Show:

Streams inplace Class

Inplace text editor tool to edit the content or attribute of a stream

Constructor

Streams inplace

(
  • [options]
)

Parameters:

  • [options] Object optional

    used to pass options

    • inplaceType String

      Required. The type of the fieldInput. Can be "textarea", "text" or "select"

    • [convert] Array optional

      The characters to convert to HTML. Pass an array containing zero or more of "\n", " "

    • [publisherId] String optional

      Required if stream option is empty. The publisher's user id.

    • [streamName] String optional

      Required if stream option is empty. The stream's name.

    • [stream] Stream optional

      Optionally pass a Streams.Stream object here if you have it already

    • [field] String optional

      Optional, name of a field to change instead of the content of the stream

    • [attribute] String optional

      Optional, name of an attribute to change instead of a field.

    • [inplace] Object optional

      Additional fields to pass to the child Q/inplace tool, if any

    • [create] Function optional

      Optional. You can pass a function here, which takes the tool as "this" and a callback as the first parameter, is supposed to create a stream and call the callback with (err, stream). If omitted, then the tool doesn't render.

    • [onLoad] Q.Event optional
    • [onUpdate] Q.Event optional
    • [onError] Q.Event optional

Item Index